Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add zenodo json file to fix title and contributors #139

Merged

Conversation

mheikenfeld
Copy link
Member

Currently the doi on zenodo creates title and authors automatically from the repo info. This leads to some unwanted behavior.

  • Not really consistent and complete author/contributor list such as partially cryptic Github usernames and lacking the author information for those who have not contributed code via Github).
  • Not enoguh control over the title

This can be fixed with a .zenodo.json file, where we can give some of the information explicitly, while other things like the version will be taken directly from the repo.

I have added my author information, maybe everyone can add their information as part of this PR..

@freemansw1 freemansw1 added the documentation Updates and improvements to documentation and examples label Jun 10, 2022
@freemansw1 freemansw1 added this to the Version 1.5 milestone Jun 10, 2022
@freemansw1 freemansw1 modified the milestones: Version 1.5, Version 1.3.2 Jun 22, 2022
Copy link
Member

@JuliaKukulies JuliaKukulies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good idea, thanks @mheikenfeld! I added my name and info now. Note that @freemansw1 and @w-k-jones should stand before me when they add their names. I would suggest to simply keep the order on github based on contribution amount?

Since we have to manually update .zenodo.json, do you think we should note that somewhere, e.g. add a check point in the PR template so that new contributors directly add their names or maybe rather a check point for us to update this file with each new release?

@mheikenfeld
Copy link
Member Author

Thanks for filling in your name and Info @JuliaKukulies

@mheikenfeld
Copy link
Member Author

It would be great to get everyone's information in before we merge this in so that we get a complete list before zenodo makes use of this.. @freemansw1 @w-k-jones @fsenf @snilsn @galexsky @zssherman @zxdawn @deeplycloudy @kelcyno @rcjackson @w-herbst

@mheikenfeld
Copy link
Member Author

Please tag/add anyone that has slipped through my short search through the contributions in the different branches, thereis probably a few additional names, whose Github accounts I did not find here...

@deeplycloudy
Copy link
Contributor

@mheikenfeld just added my affiliation via PR to your branch.

@zxdawn
Copy link
Collaborator

zxdawn commented Jun 28, 2022

Em ... How could I fork @mheikenfeld 's branch to my current old branch? I come up with creating a new branch and cloning data. But, it sounds like a wrong method.

@freemansw1
Copy link
Member

There are a number of people who should be on this list that aren't on/aren't active on GitHub, so I think this is better resolved simultaneously via email. I'll send an e-mail to everyone that I think should be on this list.

snilsn and others added 2 commits June 28, 2022 21:38
Co-authored-by: Max Heikenfeld <maxheikenfeld@web.de>
@mheikenfeld
Copy link
Member Author

Em ... How could I fork @mheikenfeld 's branch to my current old branch? I come up with creating a new branch and cloning data. But, it sounds like a wrong method.

@JuliaKukulies @snilsn @deeplycloudy: Maybe one of you could quickly explain how you set up the pull request to the pull request, struggling with the same right now..

@mheikenfeld
Copy link
Member Author

How about about adding something like the "tobac community" as the first author and then all the individual names. I've seen this in a few examples of citations on the web, often with big collaborations or institutions, but I'll try to dig out an example of something more similar to us... This would keep us from having the order of the contributors play too much of a role and also mean that we will have a constant way that the citation would look like in a name/year format, whatever happens to the individual contributors to the package in the future....

@fsenf
Copy link
Member

fsenf commented Jun 29, 2022

Agree! The first author always has a special role among all the contributing authors in a paper. Using a synonym would help us to reflect that our developers base is dynamically changing ...

@snilsn
Copy link
Collaborator

snilsn commented Jun 29, 2022

Maybe one of you could quickly explain how you set up the pull request to the pull request, struggling with the same right now..

I used the edit-button in your fork, here:
https://github.com/mheikenfeld/tobac/blob/zenodo_json_contributors/.zenodo.json

After filling in my information, clicking 'Propose changes' created a branch in my own fork, from which I could then do a PR.

@JuliaKukulies
Copy link
Member

How about about adding something like the "tobac community" as the first author and then all the individual names. I've seen this in a few examples of citations on the web, often with big collaborations or institutions, but I'll try to dig out an example of something more similar to us... This would keep us from having the order of the contributors play too much of a role and also mean that we will have a constant way that the citation would look like in a name/year format, whatever happens to the individual contributors to the package in the future....

Great idea!

@JuliaKukulies
Copy link
Member

Em ... How could I fork @mheikenfeld 's branch to my current old branch? I come up with creating a new branch and cloning data. But, it sounds like a wrong method.

@JuliaKukulies @snilsn @deeplycloudy: Maybe one of you could quickly explain how you set up the pull request to the pull request, struggling with the same right now..

Maybe one of you could quickly explain how you set up the pull request to the pull request, struggling with the same right now..

I used the edit-button in your fork, here: https://github.com/mheikenfeld/tobac/blob/zenodo_json_contributors/.zenodo.json

After filling in my information, clicking 'Propose changes' created a branch in my own fork, from which I could then do a PR.

Maintainers can also directly push to the PR by adding the fork of @mheikenfeld as a remote to their local clone, check out the zenodo_json_contributors branch and then push the changes from you local branch to the fork (see here for commands).

@fsenf
Copy link
Member

fsenf commented Jun 29, 2022

Maintainers can also directly push to the PR by adding the fork of @mheikenfeld as a remote to their local clone, check out the zenodo_json_contributors branch and then push the changes from you local branch to the fork (see here for commands).

This is the way how I did ...

@freemansw1 freemansw1 modified the milestones: Version 1.3.2, Version 1.4 Jun 30, 2022
@freemansw1
Copy link
Member

I sent out my e-mail this morning, but I'm going to give it a week or two before I start filling everything in. Given the timeline on this, I'm inclined to push out the milestone here to include this as v1.4.0.

@PhilipStier
Copy link

This is a good idea, thanks for setting this all up. It will also be good to list this as tobac community. Initially we could then have an alphabetic author list, which will of course be re-ordered by contributions for each paper etc. Alternatively, we could have a core contributor group listed first, but that definition quickly becomes a mess.

@freemansw1 freemansw1 changed the base branch from main to RC_v1.4.0 September 7, 2022 23:31
@freemansw1
Copy link
Member

Let's keep the first author as the "tobac community", as discussed here (this is mostly a reminder for myself).

@codecov
Copy link

codecov bot commented Sep 12, 2022

Codecov Report

❗ No coverage uploaded for pull request base (RC_v1.4.0@0d098ac). Click here to learn what that means.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             RC_v1.4.0     #139   +/-   ##
============================================
  Coverage             ?   35.00%           
============================================
  Files                ?       11           
  Lines                ?     2100           
  Branches             ?        0           
============================================
  Hits                 ?      735           
  Misses               ?     1365           
  Partials             ?        0           
Flag Coverage Δ
unittests 35.00% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@freemansw1
Copy link
Member

OK, I've made the updates here to both add in the information of everyone who e-mailed me and to make things compliant with the Zenodo JSON Schema. I'll open an issue here soon on doing CI for the JSON schema in ~1.4.1.

I've made the first author "tobac community" and reordered the author list to be:

  1. Original Creators
  2. Core Group/GitHub Admins
  3. All others

As @PhilipStier suggests above, I am imagining this as a dynamic list as new versions are implemented.

@freemansw1
Copy link
Member

I've re-requested a review from @JuliaKukulies and will wait to merge until one of @fsenf or @w-k-jones reviews. @mheikenfeld can you also take a second look at this?

@fsenf
Copy link
Member

fsenf commented Sep 13, 2022

Author list looks good in general, but I have actually no idea how to test if rendering within zenodo is working well ...

@fsenf
Copy link
Member

fsenf commented Sep 13, 2022

Oh, I approved too fast. Nils affiliation is wrong. I will update this in the next commit.

@fsenf
Copy link
Member

fsenf commented Sep 13, 2022

OK, now approved!

@freemansw1
Copy link
Member

Thanks @fsenf, I'll merge once @JuliaKukulies re-reviews.

@freemansw1
Copy link
Member

And yeah, there isn't a good way to check rendering within zenodo to my knowledge beyond validating the JSON schema. I've put an issue about that here: #178

Copy link
Member

@JuliaKukulies JuliaKukulies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, approved from my side, too

@freemansw1 freemansw1 merged commit 19d2114 into tobac-project:RC_v1.4.0 Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Updates and improvements to documentation and examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants